/**
 * Copyright © 2016-2025 The Thingsboard Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.terracloud.server.dao.device;

import com.terracloud.server.common.data.device.DeviceAccessControlMode;
import com.terracloud.server.common.data.device.DeviceAccessControlRule;
import com.terracloud.server.common.data.device.DeviceAccessControlRuleType;
import com.terracloud.server.common.data.id.DeviceAccessControlRuleId;
import com.terracloud.server.common.data.id.TenantId;
import com.terracloud.server.common.data.page.PageData;
import com.terracloud.server.common.data.page.PageLink;

import java.util.List;

public interface DeviceAccessControlRuleService {

    /**
     * 保存设备接入控制规则
     *
     * @param rule 设备接入控制规则实体
     * @return 保存后的设备接入控制规则实体
     */
    DeviceAccessControlRule saveDeviceAccessControlRule(DeviceAccessControlRule rule);

    /**
     * 根据ID查找设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param ruleId   设备接入控制规则ID
     * @return 设备接入控制规则实体
     */
    DeviceAccessControlRule findDeviceAccessControlRuleById(TenantId tenantId, DeviceAccessControlRuleId ruleId);

    /**
     * 查找所有设备接入控制规则列表
     *
     * @param tenantId 租户ID（可为空）
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findAllDeviceAccessControlRules(TenantId tenantId, PageLink pageLink);

    /**
     * 根据文本搜索查找所有设备接入控制规则列表
     *
     * @param tenantId   租户ID（可为空）
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTextSearch(TenantId tenantId, String textSearch, PageLink pageLink);

    /**
     * 根据规则类型和文本搜索查找所有设备接入控制规则列表
     *
     * @param tenantId   租户ID（可为空）
     * @param type       规则类型
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndTextSearch(TenantId tenantId, String type, String textSearch, PageLink pageLink);

    /**
     * 根据访问控制模式和文本搜索查找所有设备接入控制规则列表
     *
     * @param tenantId   租户ID（可为空）
     * @param mode       访问控制模式
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByModeAndTextSearch(TenantId tenantId, DeviceAccessControlMode mode, String textSearch, PageLink pageLink);

    /**
     * 根据规则类型、访问控制模式和文本搜索查找所有设备接入控制规则列表
     *
     * @param tenantId   租户ID（可为空）
     * @param type       规则类型
     * @param mode       访问控制模式
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndModeAndTextSearch(TenantId tenantId, String type, DeviceAccessControlMode mode, String textSearch, PageLink pageLink);

    /**
     * 根据规则类型查找所有设备接入控制规则列表
     *
     * @param tenantId 租户ID（可为空）
     * @param type     规则类型
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByType(TenantId tenantId, String type, PageLink pageLink);

    /**
     * 根据访问控制模式查找所有设备接入控制规则列表
     *
     * @param tenantId 租户ID（可为空）
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByMode(TenantId tenantId, DeviceAccessControlMode mode, PageLink pageLink);

    /**
     * 根据规则类型和访问控制模式查找所有设备接入控制规则列表
     *
     * @param tenantId 租户ID（可为空）
     * @param type     规则类型
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndMode(TenantId tenantId, String type, DeviceAccessControlMode mode, PageLink pageLink);

    PageData<DeviceAccessControlRule> findDeviceAccessControlRules(TenantId tenantId, PageLink pageLink);

    /**
     * 根据规则值查找设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param value    规则值
     * @return 设备接入控制规则实体
     */
    DeviceAccessControlRule findDeviceAccessControlRuleByValue(TenantId tenantId, String value);
    
    /**
     * 根据规则值和类型查找设备接入控制规则
     *
     * @param value    规则值
     * @param type     规则类型
     * @return 设备接入控制规则实体列表
     */
    List<DeviceAccessControlRule> findDeviceAccessControlRulesByValueAndType(String value, DeviceAccessControlRuleType type);
    
    /**
     * 删除设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param ruleId   设备接入控制规则ID
     */
    void deleteDeviceAccessControlRule(TenantId tenantId, DeviceAccessControlRuleId ruleId);
}